Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate AVPR API int arc-validate #92

Closed
wants to merge 14 commits into from
Closed

Conversation

caroott
Copy link
Member

@caroott caroott commented Mar 21, 2024

No description provided.

@caroott caroott marked this pull request as ready for review April 3, 2024 10:58
Copy link
Member

@kMutagene kMutagene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice progress, but i think we need more separation of the different API layers (see my individual comments).

Additionally, the cli tool usage now gets a bit confusing.

  • There must be a flag for testing against an installed preview package (e.g. arc-validate validate -p test --preview to test agtainst latest installed preview version of package test)
  • Please make -pr explicit as --preview only. -pr is very similar to -pv
  • While you are at it, we should make -v --verbose only so we can use -v instead of -pv for package version

packageName = packageName
)

static member UninstallPackage(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are now 2 versions of uninstall and list. Are both used in the CLI tool? I see multiple problems with this:

  • Uninstall prints "uninstalling all package versions of {packageName}...", but that is not true since the methods uninstall preview/prod packages respectively.
  • List should just list everything (prod/preview side-by-side)

@@ -256,3 +268,142 @@ type API =
with e ->
Error e.Message

type AVPR =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here, there should be 3 levels instead of 2 (API/AVPR) in a new ARCValidationPackages.API namespace:

  • Common: top level functions that are independent of preview/prod (e.g. List)
  • Preview, AVPR: with functions that are named the same but differ internally (e.g. Install).

This can then also be mirrored in ARCValidate.API.PackageAPI for cleaner separation


type GeneralError(msg : string) =
inherit Exception(msg)

type AVPRAPI () =
member private this.BaseUri = Uri("https://avpr.nfdi4plants.org")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it necessary to use instance methods instead of static methods here?


static member List(
args: ParseResults<PackageListArgs>,
?Verbose: bool,
?Token: string
) =

match ARCValidationPackages.API.GetSyncedConfigAndCache(?Token = Token) with
match ARCValidationPackages.API.GetSyncedConfigAndCache(false, ?Token = Token) with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means we can only list prod packages, right?

@@ -63,7 +63,7 @@ module ValidateAPI =
AnsiConsole.Write(TextPath(Path.GetFullPath(root)))
AnsiConsole.MarkupLine("")

match ARCValidationPackages.API.GetSyncedConfigAndCache(?Token = token) with
match ARCValidationPackages.API.GetSyncedConfigAndCache(false, ?Token = token) with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if i understand this correctly, we can install preview/prod packages, but can only perform validation against prod?

@@ -22,7 +22,7 @@ let ``ValidateCommand CLI Tests`` =
testFixture (Fixtures.withToolExecution
true
"../../../../../publish/arc-validate"
[|"-v"; "package"; "install"; "test"; "-pv"; "2.0.0"|]
[|"-v"; "package"; "install"; "test"; "-pv"; "2.0.0"; "-pr"|]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So here we install preview version 2.0.0, but below run validate -p test -pv 2.0.0. What if there is prod/preview 2.0.0 installed side-by side? we should only use preview packages here if there is a flag.

I know that 2.0.0 should be equal on preview/prod but it is confusing nonetheless.

@kMutagene
Copy link
Member

Closed in favor of resuming from https://github.com/nfdi4plants/arc-validate/tree/avprCli

@kMutagene kMutagene closed this Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants